Repository navigation
docs: Correct quiver and streamline figure factory return types - #5823
Conversation
There was a problem hiding this comment.
| Returns a figure for a quiver plot. |
| Returns | ||
| ------- | ||
| plotly.graph_objects.Figure | ||
| A Plotly figure containing the quiver arrows. |
There was a problem hiding this comment.
| Returns | |
| ------- | |
| plotly.graph_objects.Figure | |
| A Plotly figure containing the quiver arrows. | |
| :rtype (plotly.graph_objects.Figure): returns a representation of quiver figure. |
There was a problem hiding this comment.
| Returns a figure for a streamline plot. |
| Returns | ||
| ------- | ||
| plotly.graph_objects.Figure | ||
| A Plotly figure containing the streamlines and arrows. |
There was a problem hiding this comment.
| Returns | |
| ------- | |
| plotly.graph_objects.Figure | |
| A Plotly figure containing the streamlines and arrows. | |
| :rtype (plotly.graph_objects.Figure): returns a representation of streamline figure. |
There was a problem hiding this comment.
Please remove this file. We don't add tests for docstrings.
|
Hi @camdecoster, Thank you for the review. I've addressed your requested changes in commit I've also updated the PR description to reflect the current scope. Could you please take another look when convenient? The GitHub Actions checks are still awaiting maintainer authorization. Thank you! |
|
Hi @camdecoster, I've reviewed the remaining CI failures on PR #5823. Changelog check: This PR only corrects existing docstrings. Could a maintainer add the Optional tests (Python 3.9 / pandas 1): The failure occurs in The previously requested docstring changes have also been applied. Please let me know if any further changes are needed. Thank you! |
camdecoster
changed the title
2 participants
Summary
Related to #5396.
The documentation for
create_quiver()andcreate_streamline()incorrectly described their return type asdict, although both functions returnplotly.graph_objects.Figure.This PR:
:rtypedocumentation style.Maintainer review addressed
Thank you to @camdecoster for the review.
Commit
0b3cf5eaddresses the requested changes:Returnsblocks with Sphinx return-type directives.Only the two existing figure-factory source files remain changed.
Verification
The earlier commit
1cd3b20passed 24 targeted tests, including tests from the documentation-only file that has since been removed.These historical results do not constitute full verification of the updated head. Upstream GitHub Actions are awaiting maintainer authorization.
AI assistance
AI assistance was used in preparing and reviewing this documentation change. I remain responsible for the contribution and for addressing reviewer feedback.